home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / am102.zip / EM.DOC next >
Text File  |  1993-02-16  |  9KB  |  238 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                     Event Manager Version 1.02 (Shareware)
  17.                      (C)opyright 1991, 1992 by Doug Laine 
  18.                      The Philly Exchange (609) - 927-5771
  19.  
  20.  
  21. Disclaimer:
  22.  
  23. I am responsible for NOTHING!  You are using this system totally at your
  24. own risk!  User takes sole responsibility for security and safety of any
  25. datawhile using this program.
  26.  
  27. EM is not in the Public Domain. It is shareware. This means that you are 
  28. free to copy it, upload it to bulletin boards, and share it with friends 
  29. so long as no modification is made to the files contained in this archive 
  30. but you must either register it or stop using it after thirty (30) days. 
  31. No changes made be made to the contents or archive except as required to 
  32. accommodate the default archive format of a particular BBS. No -AV's or 
  33. ads for any BBS may be placed on, or in, this archive without the express 
  34. permission of the author.
  35.  
  36.  
  37. Setup:
  38.  
  39.    The setup of Event Manager is very simple and will be very unobtrusive
  40. in the every day running of your board.  We have made it that way, so that
  41. you will be able to add multiple event capability to your PCBoard system
  42. without many changes.   In fact, it literally requires only two additional
  43. lines in your BOARD.BAT file!
  44.  
  45.    Since you are reading this document, I will assume that you have already
  46. un-zipped the file.  As you will see there is only one main file called
  47. EM.EXE.  This file is the actual program that does all the work.  You may
  48. place this anywhere you would like, provided you can run it.  Somewhere in
  49. your path is defiantly a good idea.  The shorter the path search though, the
  50. faster it will work.  Remember, this is run EACH time that the BOARD.BAT
  51. file is!
  52.  
  53.    The next thing is to make your actual event files.  I placed mine in a
  54. subdirectory off of each node.  For example, if your board directory is
  55. F:\PCB\NODE1 which is what mine is, the event files would be placed in
  56. F:\PCB\NODE1\EVENTS.  This is to keep your board directory from getting
  57. filled with a bunch of junk.  I have named each one of my event files to
  58. represent what they do.
  59.  
  60.    There are a couple of requirements for your batch files.  1.  They must
  61. end with the word BOARD so that they will re-run the system.  I do not
  62. have Event Manager add that line as some people may not want it to do that.
  63. 2.  Do not try to set the environment variables EMWEEKDAY, EMDAYNUMBER, or
  64. EMEVENT.  These are automatically added to your batch files when the system
  65. sets up the event.  They will be set to equal the right information, so you
  66. may use the information freely.  For example, if it is Sunday, then you will
  67. see the line: SET EMWEEKDAY=0 added in your EVENT.SYS file.  Also, at the
  68. end of your event file, there will be the line: SET EMWEEKDAY= to clean up
  69. these environment variables, provided there is the word BOARD at the end
  70. of your event file.
  71.  
  72.    When Event Manager creates your event file that PCBOARD will actually use
  73. it appends the above information along with one command at the very beginning
  74. of the file: EM /NEXT.  This will tell Event Manager that the event has run
  75. and that it may continue with the next event.  This will all be handled
  76. automatically when BOARD.BAT is re-run after the event.
  77.  
  78.    Ok, we have now gotten everything figured out about creating our event
  79. files.  Now we have to tell Event Manager all about them, such as when we
  80. want to run them, and what we need to change.
  81.  
  82.  
  83. Setup (Continued)
  84.  
  85.    I have included a sample events file.  This is a comma delimited file that
  86. is used to "teach" Event Manager about our events.  The sample file also 
  87. contains this information.
  88.  
  89.    1.  The first thing we need to tell Event Manager is what days we want
  90.        the event to run.  You will place the day number in this area.  Sunday
  91.        = 0 through Saturday = 6.  If you want your event to run only on
  92.        Monday, Tuesday and Thursday you would use:
  93.  
  94.           124,
  95.  
  96.    2.  This is the line number of the data you want to change in your
  97.        PCBOARD.DAT file.  We start counting at 0, so keep this in mind.
  98.        By our count, line 112 is where the event time is kept, so that is
  99.        our next chunk of data.
  100.  
  101.           112,
  102.  
  103.    3.  This is the information that we want to place on the line specified
  104.        in column two.  This will usually be the time in 24 hour format. In
  105.        the example below, you are telling the system that you want the event
  106.        to occur at 12:15am.
  107.  
  108.           00:15,
  109.  
  110.        If you want to replace something else, for example a filename you 
  111.        would specify that here.  However, if you want to just update the
  112.        PCBOARD.DAT file, in column 4 you must specify NONE.  If you don't
  113.        the system could get confused.   In our example we wanted to place
  114.        a different welcome file for each day, so in column 2 we specified
  115.        line 35, in column 4 we would place the word NONE, and here in 
  116.        column 3 we would place:
  117.  
  118.           F:\PCB\HELLO\DAY0,
  119.  
  120.    4.  This is the name of the event file that we want to use for our event.
  121.        You must place NONE here if you want this column ignored.  Otherwise
  122.        the system will try to copy the event file to EVENT.SYS and possibly
  123.        confuse PCBoard.  In our example we used:
  124.  
  125.           EVENTS\USERBKUP
  126.  
  127.    You would then repeat these steps for each event that you want to run.  
  128. You must be sure that the event times are sequential.  If you don't your
  129. event might not occur!  
  130.  
  131.    Once you have created this events file, you must convert it. The conversion
  132. will create a file called EM.INF and must be in your board directory.  This
  133. is used to keep track of all the event information.  To create this file:
  134. EM /CONVERT sample.em <RETURN>  If all went well, you will be displayed what
  135. the events look like.  DO NOT panic if it does not show any events pending,
  136. this is normal as you have not run EM in the mode to setup the first event yet.
  137.  
  138.  
  139. Setup (Continued)
  140.  
  141.    You now must edit your BOARD.BAT file.  Somewhere in the file you will find
  142. either PCB145 or VRM145.  You will be adding two lines directly above this
  143. line.
  144.  
  145.    Before:
  146.  
  147.       IF EXIST ENDPCB DEL ENDPCB
  148.       PCB145
  149.  
  150.    After:
  151.  
  152.       IF EXIST ENDPCB DEL ENDPCB
  153.       EM
  154.       IF EXIST FORCED.BAT FORCED
  155.       PCB145
  156.  
  157. Thats all the changes you will have to make to BOARD.BAT  This will allow
  158. Event Manager to function completely.  Setup is now complete!  There are
  159. additional commands, and are explained further on in the manual.  As you
  160. can see, most operations of Event Manager are totally automatic and do not
  161. require any intervention from you.
  162.  
  163. Also, there are the three environment variables automatically added to the
  164. beginning of your event files on the fly.  They are as follows:
  165.  
  166. EMWEEKDAY   - This will contain a number from 0 through 6 representing the
  167.               day of the week with 0 being Sunday.
  168.  
  169. EMDAYNUMBER - This is the day number of the year starting at January 1.
  170.  
  171. EMEVENT     - This is the number of the event that is being run.
  172.  
  173.  
  174.  
  175.  
  176. /CONVERT {filename}
  177.  
  178.    This command is used to actually create the EM.INF file.  This will 
  179.    require that you specify a filename after the /CONVERT command.  You 
  180.    must place a space after /CONVERT.  Example:
  181.  
  182.       EM /CONVERT sample.em <RETURN>
  183.  
  184.    This will take the comma delimited file and create our database for
  185.    events.
  186.  
  187.  
  188. /FORCE {event number}
  189.  
  190.    This command is used to allow you to force any event to occur right away!
  191.    Well right away is sort of an exaggeration, as it will not occur until
  192.    the next time you run BOARD.BAT.  You must specify a valid event number.
  193.    When you do, your event will be created as usual but will be placed in a
  194.    file called FORCED.BAT and will have a command EM /FORCED_RESET added to
  195.    the beginning of that file.  This will make the FORCED.BAT file go away
  196.    after it has been run.  Example:
  197.  
  198.       EM /FORCE 1 <RETURN>
  199.  
  200.  
  201. /FORCED_RESET
  202.  
  203.     Command used internally.  This is used to reset the forced event flag in
  204.     the database.  You may use this command if your system has a problem or
  205.     you decide you don't want to force your event.
  206.  
  207.  
  208. /INFO
  209.  
  210.     This is used to have Event Manager display all the event information. All
  211.     the information is self-explanatory.
  212.  
  213.  
  214. /NEXT
  215.  
  216.     Command used internally.  This is used to reset the pending event flag in
  217.     the database.  You may use this command if you want the system to go onto
  218.     the next event.
  219.  
  220.  
  221. /RESET
  222.  
  223.     This command is used if you want to start your event sequence over.  This
  224.     will make the system forget any pending events, and to find the first
  225.     event for the day.
  226.  
  227.  
  228. To Register EM:
  229.  
  230.     Send me five bucks.
  231.  
  232.     Doug Laine  C/O EM Version 1.02
  233.     661 2nd Street
  234.     Somers Point, NJ, 08244
  235.  
  236.  
  237. Enjoy.
  238.